Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Update the Security category description DOCS-627 #1989

Merged
merged 2 commits into from
Dec 26, 2023
Merged

feat: Update the Security category description DOCS-627 #1989

merged 2 commits into from
Dec 26, 2023

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Dec 21, 2023 •
edited
Loading

Improve the Security category description to highlight available features.

👀 Live preview

https://docs-627-improve-the-description-of--docs-codacy.netlify.app/faq/code-analysis/which-metrics-does-codacy-calculate/#issues

@github-actions github-actions bot temporarily deployed to Netlify December 21, 2023 14:49 Inactive
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 21, 2023 •
edited
Loading

Overall readability score: 54.28 (🔴 -0.01)

File Readability
which-metrics-does-codacy-calculate.md 60.11 (🔴 -1.76)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
which-metrics-does-codacy-calculate.md 60.11 38.32 9.64 11.9 12.93 6.49
  🔴 -1.76 🔴 -0.2 🔴 -0.27 🔴 -0.3 🔴 -0.29 🔴 -0.13

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.28 43.16 10.86 12.37 12.53 7.87
  🔴 -0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@nicklem nicklem self-assigned this Dec 21, 2023
@nicklem nicklem marked this pull request as ready for review December 21, 2023 14:52
@nicklem nicklem requested a review from a team as a code owner December 21, 2023 14:52
@github-actions github-actions bot temporarily deployed to Netlify December 26, 2023 10:35 Inactive
claudiacarpinteiro
claudiacarpinteiro approved these changes Dec 26, 2023
View reviewed changes
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@claudiacarpinteiro claudiacarpinteiro merged commit 6f80a35 into master Dec 26, 2023
7 checks passed
@claudiacarpinteiro claudiacarpinteiro deleted the DOCS-627-improve-the-description-of-detected-security-issues branch December 26, 2023 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@claudiacarpinteiro claudiacarpinteiro claudiacarpinteiro approved these changes

Assignees

@nicklem nicklem

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nicklem @claudiacarpinteiro